
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>bent_plume_model.Particle.update &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="bent_plume_model.LagElement" href="bent_plume_model.LagElement.html" />
    <link rel="prev" title="bent_plume_model.Particle.track" href="bent_plume_model.Particle.track.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="bent-plume-model-particle-update">
<h1>bent_plume_model.Particle.update<a class="headerlink" href="#bent-plume-model-particle-update" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="bent_plume_model.Particle.update">
<code class="sig-prename descclassname">Particle.</code><code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">m</em>, <em class="sig-param">T</em>, <em class="sig-param">P</em>, <em class="sig-param">Sa</em>, <em class="sig-param">Ta</em>, <em class="sig-param">t</em><span class="sig-paren">)</span><a class="headerlink" href="#bent_plume_model.Particle.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Store the instantaneous values of the particle properties</p>
<p>During the simulation, it is often helpful to keep the state space
variables for each particle stored within the particle, especially
since each particle type (soluble or insoluble) can have different
sizes of arrays for m.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>m</strong><span class="classifier">ndarray</span></dt><dd><p>Current masses (kg) of the particle components</p>
</dd>
<dt><strong>T</strong><span class="classifier">float</span></dt><dd><p>Current temperature (K) of the particle</p>
</dd>
<dt><strong>P</strong><span class="classifier">float</span></dt><dd><p>Local pressure (Pa)</p>
</dd>
<dt><strong>Sa</strong><span class="classifier">float</span></dt><dd><p>Local salinity surrounding the particle (psu)</p>
</dd>
<dt><strong>Ta</strong><span class="classifier">float</span></dt><dd><p>Local temperature surrounding the particle (K)</p>
</dd>
<dt><strong>t</strong><span class="classifier">float</span></dt><dd><p>age of the particle–time since it was released into the water 
column (s)</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
  <li><a href="bent_plume_model.Particle.html">bent_plume_model.Particle</a><ul>
      <li>Previous: <a href="bent_plume_model.Particle.track.html" title="previous chapter">bent_plume_model.Particle.track</a></li>
      <li>Next: <a href="bent_plume_model.LagElement.html" title="next chapter">bent_plume_model.LagElement</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/bpm/bent_plume_model.Particle.update.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>